[WIP] Add a logger #1124

Soare-Robert-Daniel · 2025-08-06T14:26:31Z

Summary

Will affect visual aspect of the product

NO

Screenshots

Test instructions

Run an import in Debug mode and check the Logs tab
Check the errors when importing a bad feed
Check the email with the reporting (you will have SMTP setup, and you can manually trigger the event WP Control plugin )

Important

Test with and without PRO version: https://github.com/Codeinwp/feedzy-rss-feeds-pro/pull/927

Check before Pull Request is ready:

I have written a test and included it in this PR
I have run all tests and they pass
The code passes when running the PHP CodeSniffer
Code meets WordPress Coding Standards for PHP, HTML, CSS and JS
Security and Sanitization requirements have been followed
I have assigned a reviewer or two to review this PR (if you're not sure who to assign, we can do this step for you)

Closes https://github.com/Codeinwp/feedzy-rss-feeds-pro/issues/845

pirate-bot · 2025-08-07T14:18:03Z

Plugin build for 803d75f is ready 🛎️!

Download build

Note

You can preview the changes in the Playground

Copilot

Pull Request Overview

This PR adds comprehensive logging functionality to Feedzy RSS Feeds, introducing a structured logging system to help debug import issues and monitor system health.

Implements a new JSON-based logger with configurable log levels (debug, info, warning, error, none)
Adds a logs management interface in the settings with filtering, export, and email reporting capabilities
Replaces legacy themeisle_log_event usage throughout the codebase with the new logging system

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
includes/admin/feedzy-rss-feeds-log.php	Core logging class implementing singleton pattern with file-based JSON logging
includes/admin/feedzy-rss-feeds-task-manager.php	Manages scheduled tasks for log cleanup and email reporting
includes/layouts/settings.php	Updated settings page to include logs configuration and viewer tab
includes/layouts/feedzy-logs-viewer.php	New logs viewer interface with filtering and export functionality
includes/layouts/feedzy-email-report.php	Email template for weekly error reports
tests/test-log.php	Comprehensive unit tests for the logging functionality
tests/e2e/specs/logger.spec.js	End-to-end tests for the logging interface
includes/admin/feedzy-rss-feeds-import.php	Updated import process to use new logging system extensively
css/settings.css	Styling for the new logs interface
js/feedzy-setting.js	JavaScript for log management UI interactions

Copilot · 2025-08-11T15:29:06Z

includes/layouts/feedzy-logs-viewer.php

+
+		if ( is_wp_error( $logs ) ) {
+			printf(
+				'<p>%$1s(%2$s)</p>',


There's a syntax error in the printf function call. The format string has mismatched placeholders - it should be '%1$s (%2$s)' but currently shows '%$1s(%2$s)' with incorrect placeholder syntax.

Suggested change

'<p>%$1s(%2$s)</p>',

'<p>%1$s (%2$s)</p>',

Copilot · 2025-08-11T15:29:06Z

includes/admin/feedzy-rss-feeds-log.php

+		header( 'Expires: 0' );
+		header( 'Connection: Keep-Alive' );
+		header( 'Cache-Control: must-revalidate' );
+		header( 'Pragma: public' );


The code uses filesize() directly without checking if the file exists, but earlier checks use $this->log_file_exists() and $this->is_log_readable(). This could cause a PHP warning if the file doesn't exist at this point due to race conditions.

Suggested change

header( 'Pragma: public' );

header( 'Pragma: public' );

if ( ! $this->log_file_exists() || ! $this->is_log_readable() ) {

return new WP_Error( 'no_logs', '', array( 'status' => 404 ) );

}

Copilot · 2025-08-11T15:29:06Z

includes/admin/feedzy-rss-feeds-log.php

+		header( 'Cache-Control: must-revalidate' );
+		header( 'Pragma: public' );
+		header( 'Content-Length: ' . filesize( $this->filepath ) );
+


Similar to the filesize issue, readfile() is called without checking if the file still exists. Consider adding a final file existence check before these file operations.

Suggested change

// Final check before reading the file.

if ( ! file_exists( $this->filepath ) || ! is_readable( $this->filepath ) ) {

return new WP_Error( 'no_logs', '', array( 'status' => 404 ) );

}

Copilot · 2025-08-11T15:29:07Z

includes/admin/feedzy-rss-feeds-import.php

 				} elseif ( strpos( $feed_img_tag, '[#item_custom' ) !== false ) {
+					$value = '';


[nitpick] The variable $value is declared but may not be used when the business/personal conditions are false. Consider moving this declaration inside the conditional block or providing a default value that's more meaningful.

Suggested change

$value = '';

$value = null;

Copilot · 2025-08-11T15:29:07Z

tests/test-image-import.php

@@ -70,7 +76,7 @@ public function test_import_image_special_characters() {
 		$import_errors = array();


The variable $import_errors is declared but never used in this test method. Since the logging system has changed, this variable appears to be leftover from the old implementation and should be removed.

poonam279 · 2025-08-12T09:01:51Z

@Soare-Robert-Daniel, I noticed two things so far:

The export file is in JSONL format.
I created an import job, but the Info section shows repeated entries for Running job options via feedzy_shortcode_options. Is it intentional?

Soare-Robert-Daniel · 2025-08-12T09:05:56Z

The export file is in JSONL format.

This is intentional. The file is for us to analyze, its scope is to be given to support, then posted into the Github issues.

I created an import job, but the Info section shows repeated entries for Running job options via feedzy_shortcode_options. Is it intentional?

Yes

poonam279 · 2025-08-12T11:45:08Z

@Soare-Robert-Daniel, I have used this feed URL https://www.nasa.gov/feeds/podcasts/explorers-apollo and the full content imported without any issue but the log shows an error Full content URL response received.

Could you please let me know why it appears?

Soare-Robert-Daniel · 2025-08-12T15:03:51Z

@Soare-Robert-Daniel, I have used this feed URL https://www.nasa.gov/feeds/podcasts/explorers-apollo and the full content imported without any issue but the log shows an error Full content URL response received.

This was marked wrong as an error, it was supposed to appear only for debug. Thanks for checking 🙏

HardeepAsrani

Looks good, left a few suggestions.

HardeepAsrani · 2025-08-13T07:26:47Z

includes/admin/feedzy-rss-feeds-log.php

+	public function register_endpoints() {
+		register_rest_route(
+			'feedzy/v1',
+			'/logs/download',
+			array(
+				'methods'             => 'GET',
+				'callback'            => array( $this, 'export_logs_endpoint' ),
+				'permission_callback' => function () {
+					return current_user_can( 'manage_options' );
+				},
+			)
+		);
+		register_rest_route(
+			'feedzy/v1',
+			'/logs/delete',
+			array(
+				'methods'             => 'GET',
+				'callback'            => array( $this, 'delete_log_file_endpoint' ),
+				'permission_callback' => function () {
+					return current_user_can( 'manage_options' );
+				},
+			)
+		);
+	}


I would make the second route either a POST or a DELETE request as it is not a read operation.

HardeepAsrani · 2025-08-13T07:30:22Z

includes/admin/feedzy-rss-feeds-log.php

+	public static function debug( $message, array $context = array() ) {
+		self::log( self::DEBUG, $message, $context );
+	}
+
+	/**
+	 * Log an info message.
+	 *
+	 * @since 5.1.0
+	 * @param string               $message The log message.
+	 * @param array<string, mixed> $context The log context.
+	 * @return void
+	 */
+	public static function info( $message, array $context = array() ) {
+		self::log( self::INFO, $message, $context );
+	}
+
+	/**
+	 * Log a warning message.
+	 *
+	 * @since 5.1.0
+	 * @param string               $message The log message.
+	 * @param array<string, mixed> $context The log context.
+	 * @return void
+	 */
+	public static function warning( $message, array $context = array() ) {
+		self::log( self::WARNING, $message, $context );
+	}
+
+	/**
+	 * Log an error message.
+	 *
+	 * @since 5.1.0
+	 * @param string               $message The log message.
+	 * @param array<string, mixed> $context The log context.
+	 * @return void
+	 */
+	public static function error( $message, array $context = array() ) {
+		self::log( self::ERROR, $message, $context );
+	}


It will be great to have a trace of the error by including the first parameter to be __FUNCTION__ specially if it's made for debugging so one can easily debug which method threw the error.

Soare-Robert-Daniel self-assigned this Aug 6, 2025

Soare-Robert-Daniel added the pr-checklist-skip Allow this Pull Request to skip checklist. label Aug 6, 2025

Soare-Robert-Daniel force-pushed the feat/debug-log branch from cd0e345 to 9c475df Compare August 7, 2025 14:16

Soare-Robert-Daniel marked this pull request as ready for review August 7, 2025 14:16

Soare-Robert-Daniel force-pushed the feat/debug-log branch from 9c475df to 574bade Compare August 11, 2025 09:16

pirate-bot added the pr-checklist-complete The Pull Request checklist is complete. (automatic label) label Aug 11, 2025

Soare-Robert-Daniel force-pushed the feat/debug-log branch from 71664d0 to ae65e5c Compare August 11, 2025 13:32

Soare-Robert-Daniel requested a review from Copilot August 11, 2025 15:27

Copilot AI reviewed Aug 11, 2025

View reviewed changes

Soare-Robert-Daniel requested a review from HardeepAsrani August 11, 2025 15:38

HardeepAsrani approved these changes Aug 13, 2025

View reviewed changes

Soare-Robert-Daniel force-pushed the feat/debug-log branch from 224275f to 9110416 Compare August 13, 2025 12:42

Soare-Robert-Daniel added 13 commits August 14, 2025 10:02

feat: debug logger and viewer

0ef4618

feat: UI, export and email report

d32e1c2

feat: add task manager

3fa8da7

feat: try to replace the old system for import run details

799159f

chore: replace all themeisle_log_event

2a29923

chore: add unit test

d223b32

chore: unit tests

65efe07

chore: fix clean up test

24f6cc2

chore: add E2E tests

59ac3d4

chore: copilot review

2d836da

fix: cron names

d2a015b

refactor: logs delete endpoint

fd145f9

feat: add support for function and line calling

957a500

Soare-Robert-Daniel added 5 commits August 14, 2025 10:02

chore: add support for 'themeisle_log_event'

f1070be

chore: use lowercase levels

a3c70af

chore: add quick links

1f029e2

chore: phpstan

5cd8c70

fix: phpunit

803d75f

Soare-Robert-Daniel force-pushed the feat/debug-log branch from b7b6a7b to 803d75f Compare August 14, 2025 07:07

Soare-Robert-Daniel merged commit baea309 into development Aug 14, 2025
9 checks passed

Soare-Robert-Daniel deleted the feat/debug-log branch August 14, 2025 07:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] Add a logger #1124

[WIP] Add a logger #1124

Uh oh!

Soare-Robert-Daniel commented Aug 6, 2025 •

edited

Loading

Uh oh!

pirate-bot commented Aug 7, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

poonam279 commented Aug 12, 2025

Uh oh!

Soare-Robert-Daniel commented Aug 12, 2025

Uh oh!

poonam279 commented Aug 12, 2025

Uh oh!

Soare-Robert-Daniel commented Aug 12, 2025

Uh oh!

HardeepAsrani left a comment

Uh oh!

HardeepAsrani Aug 13, 2025

Uh oh!

HardeepAsrani Aug 13, 2025

Uh oh!

Uh oh!

Uh oh!

+		// Final check before reading the file.
+		if ( ! file_exists( $this->filepath ) || ! is_readable( $this->filepath ) ) {
+			return new WP_Error( 'no_logs', '', array( 'status' => 404 ) );
+		}

		} elseif ( strpos( $feed_img_tag, '[#item_custom' ) !== false ) {
		$value = '';

		@@ -70,7 +76,7 @@ public function test_import_image_special_characters() {
		$import_errors = array();

[WIP] Add a logger #1124

[WIP] Add a logger #1124

Uh oh!

Conversation

Soare-Robert-Daniel commented Aug 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Will affect visual aspect of the product

Screenshots

Test instructions

Check before Pull Request is ready:

Uh oh!

pirate-bot commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

poonam279 commented Aug 12, 2025

Uh oh!

Soare-Robert-Daniel commented Aug 12, 2025

Uh oh!

poonam279 commented Aug 12, 2025

Uh oh!

Soare-Robert-Daniel commented Aug 12, 2025

Uh oh!

HardeepAsrani left a comment

Choose a reason for hiding this comment

Uh oh!

HardeepAsrani Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

HardeepAsrani Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Soare-Robert-Daniel commented Aug 6, 2025 •

edited

Loading

pirate-bot commented Aug 7, 2025 •

edited

Loading